Update PR template to reflect new merging strategy #1498
Conversation
.github/pull_request_template.md
Outdated
| @@ -21,7 +21,7 @@ | |||
|
|
|||
| Self checklist (all need to be checked): | |||
| - [ ] The developer has manually tested the changes and verified that the changes work | |||
| - [ ] The commits have meaningful messages (squashes happen on merge by the bot). | |||
| - [ ] The developer has squashed their branch so it contains _only one commit_, with a meaningful message (don't do this if merging a feature branch into main or incubation). | |||
There was a problem hiding this comment.
Can we say "has been squashed meaningfully" (or some other wording that fits)? I wonder if we are too strict with the 1 commit methodology. Sometimes multiple commits are good if they are isolated chunks of work.
- Implemented the table view
- Updated the text
- Review commits
- tmp
These are bad commit messages, because they are effectively "you implemented the table with feedback". But you could have:
- DS Flow support
- Admin Checkbox to enable feature
Something more "these are two different things" sorta deal. I'm not super prescriptive for what we do with our commits, but I think we just need to get rid of those "I'm working on it" sorta commits. Which can be fixed with a git commit --amend instead of a git commit.
There was a problem hiding this comment.
I agree with one commit being too strict. How about something like:
"Commits have been squashed into descriptive, self-contained units of work (e.g. 'WIP' and 'Implements feedback' style messages have been removed)"
There was a problem hiding this comment.
@andrewballantyne changes made if you'd like to approve.
alexcreasy
force-pushed
the
update-pr-template
branch
from
1f70e5f
to
7be56e9
Compare
alexcreasy
force-pushed
the
update-pr-template
branch
from
7be56e9
to
9b572c7
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: andrewballantyne The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
No description provided.